home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cat3s / confstr.z / confstr
Text File  |  1998-10-20  |  22KB  |  331 lines
  1.  
  2.  
  3.  
  4. ccccoooonnnnffffssssttttrrrr((((3333SSSS))))                                                        ccccoooonnnnffffssssttttrrrr((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _cccc_oooo_nnnn_ffff_ssss_tttt_rrrr - get configurable variables
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee <_uuuu_nnnn_iiii_ssss_tttt_dddd_...._hhhh>
  13.  
  14.      _ssss_iiii_zzzz_eeee______tttt _cccc_oooo_nnnn_ffff_ssss_tttt_rrrr _((((_iiii_nnnn_tttt _nnnn_aaaa_mmmm_eeee_,,,, _cccc_hhhh_aaaa_rrrr _****_bbbb_uuuu_ffff_,,,, _ssss_iiii_zzzz_eeee______tttt _llll_eeee_nnnn_))))_;;;;
  15.  
  16. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  17.      _cccc_oooo_nnnn_ffff_ssss_tttt_rrrr copies information relating to the UNIX system on which the
  18.      process is executing into the buffer pointed to by _b_u_f.  _l_e_n is the size
  19.      of the buffer.
  20.  
  21.      The POSIX P1003.1 interface _ssss_yyyy_ssss_cccc_oooo_nnnn_ffff [see _ssss_yyyy_ssss_cccc_oooo_nnnn_ffff(2)] provides a similar
  22.      class of configuration information, but returns an integer rather than a
  23.      string.
  24.  
  25.      The _c_o_m_m_a_n_ds available are:
  26.  
  27.      ______CCCC_SSSS______SSSS_YYYY_SSSS_NNNN_AAAA_MMMM_EEEE   Copy into the array pointed to by _b_u_f the string that would
  28.                    be returned by _uuuu_nnnn_aaaa_mmmm_eeee [see _uuuu_nnnn_aaaa_mmmm_eeee(2)] in the _s_y_s_n_a_m_e field.
  29.                    This is the name of the implementation of the operating
  30.                    system, for example, _S_y_s_t_e_m _V or _U_T_S.
  31.  
  32.      ______CCCC_SSSS______HHHH_OOOO_SSSS_TTTT_NNNN_AAAA_MMMM_EEEE  Copy into the array pointed to by _b_u_f a string that names
  33.                    the present host machine.  This is the string that would be
  34.                    returned by _uuuu_nnnn_aaaa_mmmm_eeee in the _n_o_d_e_n_a_m_e field.  This hostname or
  35.                    nodename is often the name the machine is known by locally.
  36.  
  37.                    The _h_o_s_t_n_a_m_e is the name of this machine as a node in some
  38.                    network; different networks may have different names for
  39.                    the node, but presenting the nodename to the appropriate
  40.                    network Directory or name-to-address mapping service should
  41.                    produce a transport end point address.  The name may not be
  42.                    fully qualified.
  43.  
  44.                    Internet host names may be up to 256 bytes in length (plus
  45.                    the terminating null).
  46.  
  47.      ______CCCC_SSSS______RRRR_EEEE_LLLL_EEEE_AAAA_SSSS_EEEE   Copy into the array pointed to by _b_u_f the string that would
  48.                    be returned by _uuuu_nnnn_aaaa_mmmm_eeee in the _r_e_l_e_a_s_e field.  Typical values
  49.                    might be _4._0 or _3._2.
  50.  
  51.      ______CCCC_SSSS______VVVV_EEEE_RRRR_SSSS_IIII_OOOO_NNNN   Copy into the array pointed to by _b_u_f the string that would
  52.                    be returned by _uuuu_nnnn_aaaa_mmmm_eeee in the _v_e_r_s_i_o_n field.  The syntax and
  53.                    semantics of this string are defined by the system
  54.                    provider.  Under IRIX, this is the date and time that the
  55.                    system was generated and has the form mmmmmmmmddddddddhhhhhhhhmmmmmmmm.
  56.  
  57.      ______CCCC_SSSS_MMMM_AAAA_CCCC_HHHH_IIII_NNNN_EEEE    Copy into the array pointed to by _b_u_f the string that would
  58.                    be returned by _uuuu_nnnn_aaaa_mmmm_eeee in the _m_a_c_h_i_n_e field, for example,
  59.                    _I_P_2_7 or _I_P_3_0.
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ccccoooonnnnffffssssttttrrrr((((3333SSSS))))                                                        ccccoooonnnnffffssssttttrrrr((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      ______CCCC_SSSS______AAAA_RRRR_CCCC_HHHH_IIII_TTTT_EEEE_CCCC_TTTT_UUUU_RRRR_EEEE
  75.                    Copy into the array pointed to by _b_u_f a string describing
  76.                    the instruction set architecture of the current system, for
  77.                    example, _M_I_P_S-_I_I, _m_3_2_1_0_0, or _i_8_0_4_8_6.  These names may not
  78.                    match predefined names in the C language compilation
  79.                    system.
  80.  
  81.      ______CCCC_SSSS______HHHH_WWWW______PPPP_RRRR_OOOO_VVVV_IIII_DDDD_EEEE_RRRR
  82.                    Copies the name of the hardware manufacturer into the array
  83.                    pointed to by _b_u_f.
  84.  
  85.      ______CCCC_SSSS______HHHH_WWWW______SSSS_EEEE_RRRR_IIII_AAAA_LLLL Copy into the array pointed to by _b_u_f a string which is the
  86.                    ASCII representation of the 32 bit hardware-specific
  87.                    identifier of the physical machine on which the system call
  88.                    is executed.  Note that this may be implemented in Read-
  89.                    Only Memory, via software constants set when building the
  90.                    operating system, or by other means, and may contain non-
  91.                    numeric characters.  It is anticipated that manufacturers
  92.                    will not issue the same ``32-bit identifier'' to more than
  93.                    one physical machine.  The pair of strings returned by
  94.                    ______CCCC_SSSS______HHHH_WWWW______PPPP_RRRR_OOOO_VVVV_IIII_DDDD_EEEE_RRRR and ______CCCC_SSSS______HHHH_WWWW______SSSS_EEEE_RRRR_IIII_AAAA_LLLL is likely to be unique
  95.                    across all vendor's System V implementations.
  96.  
  97.      ______CCCC_SSSS______IIII_NNNN_IIII_TTTT_TTTT_AAAA_BBBB______NNNN_AAAA_MMMM_EEEE
  98.                    Copy into the array pointed to by _b_u_f a string that is the
  99.                    pathname of the _iiii_nnnn_iiii_tttt_tttt_aaaa_bbbb file used by the currently running
  100.                    bootable operating system.  This is the same as the file
  101.                    specified by the _IIII_NNNN_IIII_TTTT_TTTT_AAAA_BBBB keyword found in the _ssss_yyyy_ssss_tttt_eeee_mmmm file
  102.                    [see _ssss_yyyy_ssss_tttt_eeee_mmmm(4)].
  103.  
  104.      ______MMMM_IIII_PPPP_SSSS______CCCC_SSSS______VVVV_EEEE_NNNN_DDDD_OOOO_RRRR
  105.                    Copy into the array pointed to by _b_u_f a string which is the
  106.                    name of the company providing the system. The vendor is the
  107.                    company actually selling the product rather than the
  108.                    company which built the product. Eg: "Silicon Graphics
  109.                    Inc".
  110.  
  111.      ______MMMM_IIII_PPPP_SSSS______CCCC_SSSS______OOOO_SSSS______PPPP_RRRR_OOOO_VVVV_IIII_DDDD_EEEE_RRRR
  112.                    Copy into the array pointed to by _b_u_f a string which is the
  113.                    name of the company providing the operating system. This is
  114.                    the name of the company which built the operating system.
  115.                    Eg: "Silicon Graphics Inc".
  116.  
  117.      ______MMMM_IIII_PPPP_SSSS______CCCC_SSSS______OOOO_SSSS______NNNN_AAAA_MMMM_EEEE
  118.                    Copy into the array pointed to by _b_u_f a string which is the
  119.                    name of the operating system. Eg: "IRIX".
  120.  
  121.      ______MMMM_IIII_PPPP_SSSS______CCCC_SSSS______HHHH_WWWW______NNNN_AAAA_MMMM_EEEE
  122.                    Copy into the array pointed to by _b_u_f a string which is the
  123.                    name of the hardware platform. This is the name of the
  124.                    platform in the pricelist. Eg: "IP19"
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. ccccoooonnnnffffssssttttrrrr((((3333SSSS))))                                                        ccccoooonnnnffffssssttttrrrr((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      ______MMMM_IIII_PPPP_SSSS______CCCC_SSSS______NNNN_UUUU_MMMM______PPPP_RRRR_OOOO_CCCC_EEEE_SSSS_SSSS_OOOO_RRRR_SSSS
  141.                    Copy into the array pointed to by _b_u_f a string which is the
  142.                    ASCII representation of the number of configured
  143.                    processors. Eg: "16"
  144.  
  145.      ______MMMM_IIII_PPPP_SSSS______CCCC_SSSS______HHHH_OOOO_SSSS_TTTT_IIII_DDDD
  146.                    Copy into the array pointed to by _b_u_f a string which is the
  147.                    ASCII representation of the host id in hex.  This example
  148.                    uses sgi.sgi.com, which has an internet address of
  149.                    192.26.75.5. Eg: "c01a4b05"
  150.  
  151.      ______MMMM_IIII_PPPP_SSSS______CCCC_SSSS______OOOO_SSSS_RRRR_EEEE_LLLL______MMMM_AAAA_JJJJ
  152.                    Copy into the array pointed to by _b_u_f a string which is the
  153.                    ASCII representation of the  OS major release number.
  154.  
  155.      ______MMMM_IIII_PPPP_SSSS______CCCC_SSSS______OOOO_SSSS_RRRR_EEEE_LLLL______MMMM_IIII_NNNN
  156.                    Copy into the array pointed to by _b_u_f a string which is the
  157.                    ASCII representation of the OS minor release number.
  158.  
  159.      ______MMMM_IIII_PPPP_SSSS______CCCC_SSSS______OOOO_SSSS_RRRR_EEEE_LLLL______PPPP_AAAA_TTTT_CCCC_HHHH
  160.                    Copy into the array pointed to by _b_u_f a string which is the
  161.                    ASCII representation of the OS patch release number.
  162.  
  163.      ______MMMM_IIII_PPPP_SSSS______CCCC_SSSS______PPPP_RRRR_OOOO_CCCC_EEEE_SSSS_SSSS_OOOO_RRRR_SSSS
  164.                    Copy into the array pointed to by _b_u_f a string which is the
  165.                    processor type. In the case of a multiprocessor, this will
  166.                    be a comma separated list with _MIPS_CS_NUM_PROCESSORS
  167.                    entries.
  168.  
  169.      ______MMMM_IIII_PPPP_SSSS______CCCC_SSSS______AAAA_VVVV_AAAA_IIII_LLLL______PPPP_RRRR_OOOO_CCCC_EEEE_SSSS_SSSS_OOOO_RRRR_SSSS
  170.                    Copy into the array pointed to by _b_u_f a string which is the
  171.                    ASCII representation of the number of processors available
  172.                    for running unrestricted processes.
  173.  
  174.      ______MMMM_IIII_PPPP_SSSS______CCCC_SSSS______SSSS_EEEE_RRRR_IIII_AAAA_LLLL
  175.                    This is the same as ______CCCC_SSSS______HHHH_WWWW______SSSS_EEEE_RRRR_IIII_AAAA_LLLL.
  176.  
  177.      ______CCCC_SSSS______XXXX_BBBB_SSSS_5555______IIII_LLLL_PPPP_3333_2222______OOOO_FFFF_FFFF_3333_2222______CCCC_FFFF_LLLL_AAAA_GGGG_SSSS
  178.                    Copy into the array pointed to by _b_u_f a string which can be
  179.                    given as compilation options to _c_c for a 32-bit programming
  180.                    model.
  181.  
  182.      ______CCCC_SSSS______XXXX_BBBB_SSSS_5555______IIII_LLLL_PPPP_3333_2222______OOOO_FFFF_FFFF_3333_2222______LLLL_DDDD_FFFF_LLLL_AAAA_GGGG_SSSS
  183.                    Copy into the array pointed to by _b_u_f a string which can be
  184.                    given as linking options to _c_c for a 32-bit programming
  185.                    model.
  186.  
  187.      ______CCCC_SSSS______XXXX_BBBB_SSSS_5555______IIII_LLLL_PPPP_3333_2222______OOOO_FFFF_FFFF_3333_2222______LLLL_IIII_BBBB_SSSS
  188.                    Copy into the array pointed to by _b_u_f a string which can be
  189.                    given as library options to _c_c for a 32-bit programming
  190.                    model.
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. ccccoooonnnnffffssssttttrrrr((((3333SSSS))))                                                        ccccoooonnnnffffssssttttrrrr((((3333SSSS))))
  203.  
  204.  
  205.  
  206.      ______CCCC_SSSS______XXXX_BBBB_SSSS_5555______IIII_LLLL_PPPP_3333_2222______OOOO_FFFF_FFFF_3333_2222______LLLL_IIII_NNNN_TTTT_FFFF_LLLL_AAAA_GGGG_SSSS
  207.                    Copy into the array pointed to by _b_u_f a string which can be
  208.                    given as options to _l_i_n_t for a 32-bit programming model.
  209.  
  210.      ______CCCC_SSSS______XXXX_BBBB_SSSS_5555______IIII_LLLL_PPPP_3333_2222______OOOO_FFFF_FFFF_BBBB_IIII_GGGG______CCCC_FFFF_LLLL_AAAA_GGGG_SSSS
  211.                    Copy into the array pointed to by _b_u_f a string which can be
  212.                    given as compilation options to _c_c for a 32-bit with long
  213.                    off_t programming model.
  214.  
  215.      ______CCCC_SSSS______XXXX_BBBB_SSSS_5555______IIII_LLLL_PPPP_3333_2222______OOOO_FFFF_FFFF_BBBB_IIII_GGGG______LLLL_DDDD_FFFF_LLLL_AAAA_GGGG_SSSS
  216.                    Copy into the array pointed to by _b_u_f a string which can be
  217.                    given as linking options to _c_c for a 32-bit with long off_t
  218.                    programming model.
  219.  
  220.      ______CCCC_SSSS______XXXX_BBBB_SSSS_5555______IIII_LLLL_PPPP_3333_2222______OOOO_FFFF_FFFF_BBBB_IIII_GGGG______LLLL_IIII_BBBB_SSSS
  221.                    Copy into the array pointed to by _b_u_f a string which can be
  222.                    given as library options to _c_c for a 32-bit with long off_t
  223.                    programming model.
  224.  
  225.      ______CCCC_SSSS______XXXX_BBBB_SSSS_5555______IIII_LLLL_PPPP_3333_2222______OOOO_FFFF_FFFF_BBBB_IIII_GGGG______LLLL_IIII_NNNN_TTTT_FFFF_LLLL_AAAA_GGGG_SSSS
  226.                    Copy into the array pointed to by _b_u_f a string which can be
  227.                    given as options to _l_i_n_t for a 32-bit with long off_t
  228.                    programming model.
  229.  
  230.      ______CCCC_SSSS______XXXX_BBBB_SSSS_5555______LLLL_PPPP_6666_4444______OOOO_FFFF_FFFF_6666_4444______CCCC_FFFF_LLLL_AAAA_GGGG_SSSS
  231.                    Copy into the array pointed to by _b_u_f a string which can be
  232.                    given as compilation options to _c_c for a 64-bit programming
  233.                    model.
  234.  
  235.      ______CCCC_SSSS______XXXX_BBBB_SSSS_5555______LLLL_PPPP_6666_4444______OOOO_FFFF_FFFF_6666_4444______LLLL_DDDD_FFFF_LLLL_AAAA_GGGG_SSSS
  236.                    Copy into the array pointed to by _b_u_f a string which can be
  237.                    given as linking options to _c_c for a 64-bit programming
  238.                    model.
  239.  
  240.      ______CCCC_SSSS______XXXX_BBBB_SSSS_5555______LLLL_PPPP_6666_4444______OOOO_FFFF_FFFF_6666_4444______LLLL_IIII_BBBB_SSSS
  241.                    Copy into the array pointed to by _b_u_f a string which can be
  242.                    given as library options to _c_c for a 64-bit programming
  243.                    model.
  244.  
  245.      ______CCCC_SSSS______XXXX_BBBB_SSSS_5555______LLLL_PPPP_6666_4444______OOOO_FFFF_FFFF_6666_4444______LLLL_IIII_NNNN_TTTT_FFFF_LLLL_AAAA_GGGG_SSSS
  246.                    Copy into the array pointed to by _b_u_f a string which can be
  247.                    given as options to _l_i_n_t for a 64-bit programming model.
  248.  
  249.      ______CCCC_SSSS______XXXX_BBBB_SSSS_5555______LLLL_PPPP_BBBB_IIII_GGGG______OOOO_FFFF_FFFF_BBBB_IIII_GGGG______CCCC_FFFF_LLLL_AAAA_GGGG_SSSS
  250.                    Copy into the array pointed to by _b_u_f a string which can be
  251.                    given as compilation options to _c_c for a 64-bit or greater
  252.                    programming model.
  253.  
  254.      ______CCCC_SSSS______XXXX_BBBB_SSSS_5555______LLLL_PPPP_BBBB_IIII_GGGG______OOOO_FFFF_FFFF_BBBB_IIII_GGGG______LLLL_DDDD_FFFF_LLLL_AAAA_GGGG_SSSS
  255.                    Copy into the array pointed to by _b_u_f a string which can be
  256.                    given as linking options to _c_c for a 64-bit or greater
  257.                    programming model.
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. ccccoooonnnnffffssssttttrrrr((((3333SSSS))))                                                        ccccoooonnnnffffssssttttrrrr((((3333SSSS))))
  269.  
  270.  
  271.  
  272.      ______CCCC_SSSS______XXXX_BBBB_SSSS_5555______LLLL_PPPP_BBBB_IIII_GGGG______OOOO_FFFF_FFFF_BBBB_IIII_GGGG______LLLL_IIII_BBBB_SSSS
  273.                    Copy into the array pointed to by _b_u_f a string which can be
  274.                    given as library options to _c_c for a 64-bit or greater
  275.                    programming model.
  276.  
  277.      ______CCCC_SSSS______XXXX_BBBB_SSSS_5555______LLLL_PPPP_BBBB_IIII_GGGG______OOOO_FFFF_FFFF_BBBB_IIII_GGGG______LLLL_IIII_NNNN_TTTT_FFFF_LLLL_AAAA_GGGG_SSSS
  278.                    Copy into the array pointed to by _b_u_f a string which can be
  279.                    given as options to _l_i_n_t for a 64-bit or greater
  280.                    programming model.
  281.  
  282.      _cccc_oooo_nnnn_ffff_ssss_tttt_rrrr fails if the following is true:
  283.  
  284.      _EEEE_IIII_NNNN_VVVV_AAAA_LLLL        _b_u_f does not point to a valid address.
  285.  
  286. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  287.      Upon successful completion, the value returned indicates the buffer size
  288.      in bytes required to hold the complete value and the terminating null
  289.      character.  If this value is no greater than the value passed in _l_e_n, the
  290.      entire string was copied; if this value is greater than _l_e_n, the string
  291.      copied into _b_u_f has been truncated to _l_e_n-_1 bytes plus a terminating null
  292.      character.
  293.  
  294.      Otherwise, a value of -1 is returned and _eeee_rrrr_rrrr_nnnn_oooo is set to indicate the
  295.      error.
  296.  
  297. UUUUSSSSAAAAGGGGEEEE
  298.      A good starting guess for _l_e_n is 257, which is likely to cover all
  299.      strings returned by this interface in typical installations.
  300.  
  301. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  302.      _uuuu_nnnn_aaaa_mmmm_eeee(2), _gggg_eeee_tttt_hhhh_oooo_ssss_tttt_nnnn_aaaa_mmmm_eeee(3), _gggg_eeee_tttt_hhhh_oooo_ssss_tttt_iiii_dddd(3), _ssss_yyyy_ssss_cccc_oooo_nnnn_ffff(3C), _<<<<_uuuu_nnnn_iiii_ssss_tttt_dddd_...._hhhh_>>>>,
  303.      _<<<<_rrrr_eeee_gggg_eeee_xxxx_pppp_...._hhhh_>>>>
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.                                                                         PPPPaaaaggggeeee 5555
  328.  
  329.  
  330.  
  331.